Vcenter Lcm Deployment MigrationUpgrade ApplySpec

The Vcenter Lcm Deployment MigrationUpgrade ApplySpec class provides the POST /vcenter/lcm/deployment/migration-upgrade?action=apply configuration. It allows configurations such as stopping at specific points of the upgrade or to configure a time window for the switchover. For more information about the upgrade process refer to POST /vcenter/lcm/deployment/migration-upgrade?action=apply.

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "pause": "string",
    "start_switchover": "string"
}

string

pause

Optional

Allows the upgrade to be stopped at predefine points of the process. For more information about the available pause options check Vcenter Lcm Deployment MigrationUpgrade PausePolicy.

For more information see: Vcenter Lcm Deployment MigrationUpgrade PausePolicy.

This property was added in vSphere API 9.0.0.0.

If missing or null the upgrade process will complete without stopping.

string As date-time As date-time

start_switchover

Optional

Instructs the upgrade process to start the switchover operation after the given time. If the upgrade process is not ready for the switchover at the given time and end switchover is not provided the upgrade will wait for the preparation to complete to start the switchover thus resulting in the shortest possible switchover duration. The option cannot be set if Vcenter Lcm Deployment MigrationUpgrade ApplySpec.pause is set with value Vcenter Lcm Deployment MigrationUpgrade PausePolicy.BEFORE_SWITCHOVER, if such configuration is attempted will result in Vapi Std Errors InvalidArgument.

This property was added in vSphere API 9.0.0.0.

If missing or null the upgrade process will execute the switchover operation as soon as possible.

Parameter To

Vcenter Lcm Deployment MigrationUpgrade apply